docs(nav): surface the webhook pages - #94
Merged
Merged
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
The overview keeps the envelope, snapshot, presence matrix, and object tables on the existing slug. Each event type gets its own page: when it fires, a one-row status/populated/null snapshot table with the populated blocks linked to their field tables, and the golden-fixture example. Object headings and Type-column links use type-style capitalization; field names stay lowercase code. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The Webhooks guide goes under WalletConnect Pay after Test mode. The event reference gets a top-level Webhook Reference tab: the payload carries its own api_version (2026-05-18), independent of the REST version, so it belongs neither in the API Reference tab nor in a feature group. Tabs move to the navigation root with versions nested inside API Reference only, since the other tabs were identical across version blocks; the version picker now shows only where it applies. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
xikimay
force-pushed
the
docs/webhooks-navigation
branch
from
August 3, 2026 10:29
ef2654d to
5d684b6
Compare
xikimay
marked this pull request as ready for review
August 3, 2026 13:49
skibitsky
approved these changes
Aug 3, 2026
expandable collapsed the one thing each page exists for behind a See all N lines link, and the code block title just repeated the page title. Plain json blocks match the guide and the ecommerce reference. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The envelope and data tables restated what the event reference owns, and both copies had already drifted (example timestamps, reference_id nullability). The guide now names the four fields that decide handler correctness and links out for the rest; the timestamp parsing pitfall moves into the parse-tolerantly warning. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs side of the webhooks rollout, in three moves:
Navigation. The Webhooks guide goes under WalletConnect Pay after Test mode (it is a product feature). The event reference gets a top-level Webhook Reference tab: the payload carries its own api_version (2026-05-18), independent of the REST version, so it belongs neither in the API Reference tab nor in a feature group. This is the GitHub/Shopify pattern (dedicated webhooks section) rather than Stripe's, which only works there because Stripe events share the REST api_version.
Version picker scoping. Payments and Webhook Reference were identical across the two version blocks; only the REST reference is versioned. Tabs move to the navigation root with versions nested inside API Reference only, so the 2026-02-18 picker no longer shows on tabs it does not apply to. Collapses 130 lines of duplicated nav.
Per-event pages. The reference splits into an overview (envelope, snapshot, presence matrix, objects, same slug as before so existing links hold) plus one page per event type with its presence row and golden-fixture example. Examples verified byte-identical to the MX main fixtures.